Copyright: © Teubner & Associates, Inc. - 1998
Citation: © Teubner & Associates, Inc. - 1998


Faxgate FAX Server Control Program
Introduction

Menu Items

Components

Errors


Introduction

The Faxgate Service Control Program is an application which runs from any NT workstation.

The Faxgate Service Control Program offers a user interface to the Faxgate Service.   The major component is the Message Service which runs independently of the Control Program.  However the Service can be stopped, started or monitored from the Control Program.  Faxes will not be sent or received if the Service is not running.  Other Control Program components relate to configuration and monitoring of the FAX Server.

If adding or deleting components via the Control Program, the Service must be stopped and restarted to recognise the changes.  In addition, fax line/driver modifications require the Service to be stopped and restarted.

Click on any of the Control Program components you would like to know more about:


Menu Items

Click on any of the Menu Items you would like to know more about:

Servers Menu

Components Menu

View Menu

Troubleshooting Menu

Help Menu


Select server...

To observe the status of another FAX Server select the Servers menu item and then Select server… .

Select the appropriate Server and click the Connect to server button.  It may take some time to connect to the Server depending on network traffic.  An Abort connection option is available if connection time is taking too long.


Import snapshot...

This option is primarily used by Technical Support staff for debugging.  The import facility enables you to view a captured snapshot file.  For further information see Troubleshooting.


New component

Select this menu item any time a new component is required.  Installation adds the minimum components, but further customization may be required, e.g. call charging.  A menu of components is displayed:

Components which already exist and do not support multiple instances are greyed-out and unavailable for selection.


Remove component

Select this menu item when a component is to be removed.  The currently selected component is deleted.


View - Icons

Displays the Control Program components as large icons as shown below:


View - List

Displays the Control Program components as a list (Name/Type) with small icons as shown below:

This is the default display.  Click on the column label Name or Type to sort the components alphabetically or by component “type”.


Logging options...

Check the level of logging required in the NT Event Log as displayed below:

See Troubleshooting for further details on Logging options.


Troubleshooting

Click on any of the Logging options you would like to know more about:


Log Dialing Failures

Logs all dialing failure information, such as number or retries and the time of each try, along with the status number associated with the failed message.


Log Full Message Trace

Logs all message information (sent and received).


Log Application Printing Events

Logs all AppPrint transactions.


Log Fax Driver Events

Logs calls to the Fax driver API.


Log all File Deletions

Logs details whenever a file is deleted.  Useful if tracking "disappearing files".


Log Module Loading & Shutdown

Logs the starting up, name and version no. of each DLL.  Useful for checking DLL versions.


Log Serial Routing Interface Messages

Log all Serial Routing Interface (SRI) transactions.  Necessary for configuration of the SRI component.


Log Thread Creation

Used for debugging Dr Watson errors.


Log Resource Usage

Used for debugging resource problems.


Send a test fax...

This facility is used to generate a test fax.  Select the file to be sent and the fax number to send to.


Snapshot...

This facility it used to send important information back to Technical Support for troubleshooting purposes.  The Fax Administrator creates a zipped file/s by selecting the items required in the What to get section and clicking on Get snapshot now button.

If there are MAPI e-mail facilities on your site then simply click the Mail it button and your mail Send To: screen will appear.  Details for sending will automatically be inserted along with the icon of zipped ‘snapshot’ information intended for System Solutions Technical Support.  Comments etc, may also be added to this mail message.

Use the Save to file button should e-mail not be available to you.  Copy file/s onto a diskette and send to Technical Support as soon as possible.


Help - About

Displays current version of the Faxgate Service Control Program.  To display the version of the Faxgate Service, select the Faxgate Service icon.


Components

Click on any of the Control Program Components you would like to know more about:


Call Cost

Call Cost

Fax calls can be charged to individual users, workgroups, departments, clients or matter numbers.  Calls can be charged at PTT rates, per page or a user defined basis.  Charging defaults to standard PTT rates according to a charge table.  If there is no call cost component, deferred messages are sent at 6pm.

To Add a Call Cost component:

1.	Select File, New - Call Cost table.

2.	Enter the filename to be used in calculating the cost of a fax call.  No path is required as the charges table must be located in the CHARGES sub-directory of the FAX Server application directory (e.g. c:\mm\charges).

The following files are supplied:

charges.ade	Adelaide	charges.akl	Auckland

charges.bne	Brisbane	charges.can	Canberra

charges.chu	Christchurch	charges.hob	Hobart

charges.hkg	Hong Kong	charges.mlb	Melbourne

charges.per	Perth	charges.sin	Singapore

charges.syd	Sydney	charges.wgt	Wellington

•	NB.  If there is no charges table applicable for your location, see Accounting in section 3 of your manual.  The charge table can be customised using any ASCII editor.

3.	Enter the time your Off Peak Rates END into on Weekdays, up to, and the START time of your Off Peak Rates into On Weekdays, after.

E.g. Off Peak Rates from 8.30pm to 6.30am

On Weekdays, up to:	6:30

On Weekdays, after:	20:30

If your Telecommunications company offers OFF PEAK rates for weekends, cross the box All day Saturday and Sunday.  If this box is left uncrossed, the above times apply for the whole week.

To Disable Call costing:

1.	Select the Call Cost icon.

2.	Select Remove from the File menu.


CVR Cover Page

CVR Cover Page

Select the CVR Cover Page component to configure the page layout when converting ASCII templates (*.cvr) into fax images.  This includes the font, page width and height, as well as the left, right, top and bottom margins.

Directory containing cover page files

Where there is no path specified in the cover file template field (e.g. mm.cvr), the FAX Server looks for the file in this directory.

Directory containing image files

Where there is no path specified in an image name to be inserted on the cover page (e.g. @/header.tif@/), the FAX Server looks for the file in this directory.

•	NB.  For more information on Cover pages see the Cover Page Section in the MESSAGEmanager 32 bit FAX Server Reference Manual, Part 1.

To Add a CVR Cover Page component:

1.	Select File, New - CVR Cover Page formatter.

•	NB.  CVR files cannot be processed if the CVR Cover Page component is removed.


ANO Cover Page

ANO Cover Page

The merging of .ano cover page templates with the original TIFF file is done by the Merge ANO Cover Page DLL.

NB.	For more information on Cover pages see the Cover Page Section in the MESSAGEmanager 32 bit FAX Server Reference Manual, Part 1.

To Add a ANO Cover Page component:

1.	Select File, New - ANO Cover Page formatter.

•	NB.  ANO Cover Pages cannot be processed if the ANO Cover Page component is removed.


Disk Monitor

Disk Monitor

Select the Disk Monitor component to control the monitoring of disk space and notification when space is low.  There are two areas which can be monitored and various ways of notifying a problem:

Database Directories

This monitors the disk space on the disk where the send and receive database files are stored.  This may be a network drive.  Enter a value in MB.

Workspace Disk

This monitors the local disk of the FAX server.  As sent and received files are temporarily stored here, it is important this disk is monitored.  Enter a value in MB.

Notification Method

When the disk space is less than that specified, there are three notification methods available.  Check the required box(es).

•	Flashing Icon

The disk monitor icon flashes for as long as the disk space is below the specified value.

•	Beep

An audible beep occurs for as long as the disk space is below the specified value.

•	Notify to Mail Administrator

A record is written into a receive database and error will be mailed to  the  administrator's mailbox by the FAX Connector or Mail Gateway.


Fax Line X

Fax Line X

Each Fax Line component controls the operation of a single fax line.  The Control Program automatically creates the correct number of Fax Line components based on the number of fax lines installed (as configured by the Brooktrout and GammaFax setup).

Click on any of the items within the Fax Line window for more information:

See Also	Fax Line Icons


Fax Line Icons

Fax Line Icons

The Control Program displays the current status of each line.

Following are the possible status’ of a fax line:

down - disabled by administrator, Fax driver not operating or Line(s) not licensed for operation.

idle – no activity

sending - currently sending a message

receiving - currently receiving a message


Fax Line - Driver

Fax Line - Driver

Identifies the fax driver in use.  See Fax Driver.


Fax Receive - Enabled

Receive - Enabled

Check the Enabled box to receive faxes on this line or deselect to disable receiving.


Fax Receive - PABX extension

Receive - PABX extension

Enter the PABX extension to which this line is connected.  The Faxgate Service uses this to match information received on the serial line from the PABX about received faxes.


Fax Receive - DB

Receive - DB

Select the database component into which received messages for this line are to be registered (e.g. Receive).  If you require this line to register received messages into a different database which is not yet defined, you should first create the database via File - New - Receive Database.


Fax Receive - Copy to Printer Enabled

Receive - Copy to Printer Enabled

Cross this box to enable automatic printing of incoming fax messages.  A list of available printers on the FAX Server will be displayed in the window on the right (next to the check box), select the printer to be used.

A different printer can be configured for each line.


Fax Send - Enabled

Send - Enabled

Send is Enabled by default.

Remove the Check in this box to disable sending on this line.


Fax Send - CSID

Send - CSID

Enter the CSID for this fax line.  The CSID (Customer Subscriber IDentification) is used during fax handshaking to indicate to the remote fax machine the identification of this line.  CSID is usually the international form of the fax number to which the recipient should reply, e.g. +61 2 99554616

In the current version, the line CSID is replicated across all lines.

The line CSID will be replaced by the user's private CSID, if configured.


Fax Send - PABX dial-out

Send - PABX dial-out

Enter the dial-out prefix necessary to get an outside line on your PABX, e.g. 0.  The dial-out string can include commas (pauses), semi-colon (wait for dial tone) or other DTMF characters.  All numbers longer than 5 digits are automatically prefixed by this string.  If the ~ character is used to prefix the destination, the dial-out string is not used.  In the current version, the PABX dial-out is replicated across all lines.


Fax Send - PABX Postfix

PABX Postfix

Enter the character(s) to terminate the dial string passed to the PABX, e.g. one or more commas.  This is useful to force a pause after dialing, where some remote fax machines respond too quickly and result in the fax driver incorrectly detecting an error signal.  Any of the DTMF characters can be entered as the Postfix.  The PABX Postfix does not apply to fax numbers 5 digits or less.


Fax Send - International dialling

Send - International dialing

Enter the dial string used to dial international numbers.  The plus sign (+) is substituted by this string, e.g. +642 9955 4616 will be dialed as 001164299554616 if 0011 is the international dial string.


Fax Send - Country Code

Send - Country Code

This field is used to compare dial strings for stripping out the local country code when dialling local numbers.  For example, 61 is Australia's country code and any international number being dialled (as indicated by +) will be stripped of the international dial sequence and the country code 61 and will be sent within Australia.


Fax Send - Area Code

Send - Area Code

This field is used to compare dial strings for stripping out the local area code when dialing local numbers.  For example, 02 is Sydney's area code and any number being dialed with an 02 prefix will be stripped of the 02 and sent locally.  If 02 is specified as the area code, then any international numbers which are prefixed by +612 are also treated as the Sydney area code.  So MESSAGEmanager will process the following dial strings correctly if configured for a country code of 61 and an area code of 02:

+610299554616

+61299554616

•	N.B.  Australian sites MUST include the 0 of the area code, e.g. "03" not "3".


Fax Send - Page Header Style

Send - Page Header Style

The default page header shows the sending CSID and the number/CSID being dialled.  This is the "From (number) To (number)" selection.  If using Brooktrout fax hardware you can replace the number with names so that the sender's name and the addressee's name appear on each page.  Select "From (name) To (name)" to use names in the page header.


Fax Driver (GF or BT)

Fax Driver (GF or BT)

The GammaFax driver is used with the GammaLink fax boards.  The GammaLink configuration file, gfax.$dc, is automatically configured by the GammaFax Configuration icons.  The GF driver uses a master profile, gfax.txt, to configure non-GammaFax defaults.

The BT Driver is used with Brooktrout fax boards.

Notification Methods:

If the driver is not running, there are three notification methods available.  Check the required box(es).

•	Flashing Icon

The driver icon flashes for as long as the driver is not operational.

•	Beep

An audible beep occurs for as long as the driver is not operational.

•	Notify to Mail Administrator

A record is written into a receive database and the error will be mailed to the administrator's mailbox by the FAX Connector or Mail Gateway.

Hardware Troubleshooting

The hardware troubleshooting options control special features of the hardware fax driver which Technical Support may ask you to enable for the purposes of further investigating an exceptional fax hardware problem.

You should not enable either of these options except in cooperation with Technical Support.


Faxgate Service

Faxgate Service

The Faxgate Service is the primary FAX Server task.  Faxes will not be sent or received if the Service is not running.

Click on any of the items you would like to know more about:


Windows NT uptime

Windows NT uptime

Displays the number of hours and minutes the NT workstation has been operating without a restart.


Faxgate Service - Status

Faxgate Service - Status

•	Running n hours n min

Service is currently operational and has been running for the displayed hours/minutes.

-	Select Stop to terminate.

•	Not running

Service is not operational.

-   Select Start to start up Service.

•	Stopping

Service is shutting down (after a Stop command).

•	Starting

Service is starting up (after a Start command)


Faxgate Service - Notifications

Faxgate Service - Notifications

If the Service has terminated abnormally or the watchdog has not been updated within 5 minutes, the Control Program can notify you in one of two ways:

•	Flashing icon

The FAX Server icon flashes for as long as the service is down.

•	Beep

An audible beep occurs for as long as the service is down.


OutsideIn Converter

OutsideIn Converter

The Outside In Converter, in conjunction with the FAX printer driver, is used to convert those Windows attachments not processed by AppPrint.

When printing spreadsheet files if you require OutsideIn to print grid lines and/or row and column headings select the appropriate box.

See the MESSAGEmanager 32 bit FAX Server Reference Manual, Part 1, for details on OutsideIn, including supported file formats, as well as OutsideIn anomalies.


Application Printing

Application Printing

The Application Printing component can be added to the Control Program if OutsideIn does not support an application type you wish to send as an attachment.  Or you may choose not to use the OutsideIn converter and rely on the application printing component for all of your attachment requirements.

See Also	Configuration for AppPrint

To configure the FAX Server to use Application Printing:

1.	Select the File Menu item, New - Application Printing.

2.	All of the registered application types installed on the FAX Server’s work station are displayed for selection.  Highlight the application type you wish to be printed via appprint.dll, and use the Add button or simply double click on it.  To remove an application type, highlight the entry (in the lower window) and click on Remove.

3.	Print-file-stable Time (seconds)

It is recommended the default setting of 20 seconds remain unchanged, unless problems occur with appprint.dll due to either a very fast or very slow work station.  Contact your Support technician for assistance in this area.

4.	Maximum allowable printing time (seconds)

The default setting of 100 seconds should be sufficient printing time.  If you are running a slow work station and the application is slow to open and print the document causing conversion errors, you may need to increase this time.  Once again if problems occur in this area you should contact your Support technician for further assistance.


Configuration for AppPrint

Configuration for AppPrint

Processing attachments for faxing is based on the File Extension.  If the file is already in a faxable format, i.e .txt or .tif, no application printing action is required and the FAX Server will handle the file appropriately.

For applications configured in the AppPrint component, the Application Printing component will attempt to launch the appropriate application and print to file using the MMFAX printer driver.  This requires the following to be set up for EVERY attachment type (i.e. extension) which AppPrint is configured for.

1.	Install or set up the application which created the file type.

2.	Use File Associations to register the appropriate extension/s with that application.

3.	Test the “Shell Print” functionality of that application as follows:

•	In Control Panel change the default Printer to the MMFAX printer.

•	Using File Manager or Explorer highlight a file with the appropriate extension (i.e. click on it once).

•	Select Print from the File menu.

If the application opens and the document automatically prints (without dialog boxes requiring manual intervention) then the Application Printing component will be able to process these attachments without further configuration.  The following applications are treated as special cases by the Application Printing component and are handled correctly even though dialog boxes may be displayed during the print process.  See Application Printing Component in the Reference Manual.

Any attachment which requires local work station knowledge, e.g. Excel macros, will not be handled correctly by the Application Printing component.  Ensure Excel does not load macros automatically on the FAX Server work station.  If you wish to fax documents of this kind, they can be pre-printed on the work station using the MMFAX printer driver and sent via Mail as a TIFF attachment.

•	N.B    If an Excel file is stored and submitted in “design mode” then the FAX Server may transmit the programming instructions.  This occurs by default in Office 95.


Print-to-fax Driver:  FAXGATE

Print-to-fax Driver

The FAX printer driver is used to convert ASCII (.CVR) cover pages, ASCII  and Windows attachments.

Print-file-stable Time (seconds)

It is recommended the default setting of 60 seconds remain unchanged, unless problems occur with printing due to either a very fast or very slow work station, or large file attachments.  Contact your Support technician for assistance in this area.


PS/PCL Converter

PS/PCL Converter

This component converts PostScript  and PCL print files into fax format.  The Lincoln PostScript /PCL interpreter must be installed separately to the FAX Server installation.

•	N.B.  Separate licensing is required for the PS/PCL Converter, should you have any problems contact Technical Support  for assistance.  You may view the Event Log for details on errors.

Enter the extensions to be handled by this component.


Receive DB

Receive DB

Information about received faxes is stored in a receive database, usually receive.dbf.  Fax lines can share a central receive database, or each line can use its own database.  Received fax messages are stored as .TIF files in the RECEIVE sub-directory of the database file.  The records within this database can be purged via Message Purging with the option to purge records older than a specified number of hours or days.  The received file(s) (within the RECEIVE sub-directory) are also deleted at the time of purging.

To add a Receive Database:

1.	Select File, New - Receive database.

To delete a Receive database:

1.	Select the appropriate Receive Database.

2.	Select File and Remove.

The Receive Component displays details about the receive queue -

•	path and filename

•	no. of records in the database

•	date and time of the oldest record

•	date and time of the newest record

•	a detail button to view the records in the receive database

To enable Message purging:

1.	Select the Enable check box.

2.	Enter the desired amount of days or hours against the “purge messages older than” prompt.

3.	Select the appropriate radio button, either days or hours.

4.	Click OK to accept.


dBase Detail

dBase Detail

•	Click on any of the column headings to sort the displayed records in that order.

•	Columns can be widened by moving the margin in the column heading.  To make a column width change permanent, select Ok to exit.  Select Cancel to ignore any column changes.

•	Click on the Columns button to Add and Remove columns.

Abort button (pending only)

Delete button

•	These buttons remove the record and associated files.

•	N.B.   If file/s are also being used by other messages, e.g. in a broadcast, then this action will affect the other messages using that file/s.


Adding & Removing Columns

Adding & Removing Columns

To Add a Column:

From the Column list on the left hand side click on the field you wish to Add to the  Detail screen.  Select the Add button, which moves the field into the Column list on the right hand side.  Use the Up and Down buttons to put the item in the order you require.

To Remove a Column:

From the Column list on the right hand side select the field to be removed and click on the Remove button.


Send DB

Send DB

Information about outgoing faxes is stored in two database files - pending.dbf  and complete.dbf .  The FAX Server polls any number of outgoing queue files which may be on different file servers or on the same file server.  The records within these databases can be purged via Message Purging with the option to purge records older than a specified number of hours or days.

To add a Send Database:

1.	Select File, New - Send database.

To delete a Send database:

1.	Select the appropriate Send Database.

2.	Select File and Remove.

The Send Component displays details about the two send queues.

Use the radio button to select pending or complete -

•	path and filename

•	no. of records in the database

•	date and time of the oldest record

•	date and time of the newest record

•	a detail button to view the records in the pending and complete databases

To enable Message purging:

1.	Select the Enable check box.

2.	Enter the desired amount of days or hours against the “purge messages older than” prompt.

3.	Select the appropriate radio button, either days or hours.

4.	Click on OK to accept.


Send Scheduler

Send Scheduler

If there is no Send Scheduler component, the default retries apply.  That is, if a message is not sent on the first attempt, it is retried four times at 1 minute, 3 minute and two 5 minute intervals.

To Add a Send Scheduler component (to change the default retries):

1.	Select File, New - Send Scheduler.

2.	If Call Batching is required select the Enable Call Batching box.

N.B.	Call Batching may not be supported by the Driver.

To return to the default retries:

1.	Select the Send Scheduler icon.

2.	Select File and Remove.


Text to Fax

Text to Fax

Select the Text to Fax component to configure the page layout when converting ASCII file attachments (.txt, .mtx, .bat, .log, .ini, .bas, .sys) into fax images.  This includes the font, page width and height, as well as the left, right, top and bottom margins.

To add a Text to Fax component:

1.	Select File, New - Text to Fax converter.

•	NB.  ASCII attachments cannot be processed if the Text to Fax component is removed.


Serial Routing Interface (SRI)

Serial Routing Interface (SRI)

How SRI works

When a call comes in, the PABX assembles data about the call and sends it out on the PABX's serial line. It also puts the call through to an extension. Faxgate Service receives the PABX data through its serial port and the fax message through a fax card. It matches up the extension digits in the PABX data with the PABX extension for the fax line which took the call. The PABX data also contains routing digits, which are what the caller originally dialled; Faxgate Service puts those routing digits into the received fax's database record, just as it would for inband signalling.

To add the Serial routing interface component

1.  Select the Control Program File menu item New - Serial routing interface.

2.  Configure the Template String:

The template string must end in some character which indicates the end of a PABX message and which doesn’t occur in the middle of a PABX message, such as ^J in the example below.  SRI relies on this terminating character to distinguish one PABX message from another.

e	extension digit

r	routing digit

d	ignore this character if it is a numeric. Match

fails if it is not numeric

?	ignore this received character. Match fails

if there is no character (i.e. past end of

received string)

*	ignore remainder of received string (if any), except the terminating character

^	used to indicate a control character, e.g.

^B	STX (start of string)

^C	ETX (end of string)

^M	CR (carriage return)

^J	LF (line feed)

All other characters are literal (including case).  There is no way to match lower case e r d or ^ ? *.

The following is an example template from an Ericcson MD110 external call:

^B85rrrree^M^J

where

^B	start of string

85	numeric message type

rrrr	4 routing digits

ee	2 digit extension (phone line no.)

^M^J	end of string identifier (CRLF)

This template would recognize the following data from the PABX as meaning 	routing digits 7777 received on extension 12.

^B85777712^M^J

3.  Configure the Bias time/Match time:

Used for calibrating the timers involved in the serial routing interface.  Default to 5 seconds each.  See Calibrating SRI.  To simplify initial setup, set the bias time to zero and the match to 30 seconds.

4.  Configure the Serial port:

The PABX should already be connected to a serial port on the FAX Server.  	Select the serial port to which the PABX is connected.

NB the mouse is usually connected to COM1.

5.  Select the Baud rate/Parity/Data bits/Stop bits

These values must match the switchboard serial port configuration.  Defaults to 9600 baud, 7 data bits, even parity and one stop bit.  The PABX may be configured for 8 data bits and no parity.

6.  Configure each Receive Fax Line component:

Using the Faxgate Service Control Program select each receive fax line component, configure the PABX extension.

7.  Until Serial routing is working properly, it is best to enable SRI logging:

Control Program - File - Debug - check the box Log Serial routing interface messages.

See Also	Testing SRI

Calibrating SRI


Testing SRI

Testing SRI

To Test SRI:

•	If the Faxgate Service is not already stopped, stop it now.  Restart the Faxgate Service and send some faxes from a fax machine into the FAX Server.

•	Check the log file for SRI messages like this:

com1: received "^B85123^X789^M^J" at 18:05:41.239; ext 123 route 789

fax line 1: no SRI record matches ext 121 at 18:05:44.521

...

com1: received "^B85125^X713^M^J" at 18:08:11.317; ext 125 route 713

fax line 2: SRI record matched ext 125 at 18:08:17.071

...

com1: received "^B85125^X713^M^J" at 18:13:21.823; ext 125 route 713

fax line 2: no SRI record matches ext 125 at 18:13:31.422

These lines show exactly what was received and when (down to the nearest millisecond), how the SRI component parsed the PABX data into extension and routing digits, and how the SRI data matched or failed to match, incoming calls.

The first example above failed because the extension digits didn't match. So check cabling and PABX extensions for fax line 1.

The second example worked, so cabling and extension numbers are OK for fax line 2. Notice that the SRI time doesn't exactly match the fax receive time. The third example failed because of timing. The next section, Calibrating SRI explains how to get this right.


Calibrating SRI

Calibrating SRI

Because of the way SRI works, the PABX message probably arrives at the Faxgate Service a few seconds before the fax card connects the incoming call. This time difference is the bias time. It is usually a positive number, about 2 seconds or so. It is remotely possible that PABX messaging takes longer than the fax card takes to answer the call, in which case the bias time would be negative.

Using the bias time, Faxgate Service can more accurately match up SRI receive times with fax receive times. But the bias time can't give 100% accuracy: timings will vary depending on the loads on the PC and PABX. The match time allows for this variability. If the Faxgate Service's best guess at matching an SRI time with a fax receive time (after correcting for the bias time) is within the match time then it's a match, otherwise Faxgate Service will log an SRI failure.

The seconds and third examples in the previous section show how this works. The bias time is 5 seconds and match time is 5 seconds (as according to the dialog box above).

•	SRI receive time is 18:08:11 (ignoring the milliseconds)

Fax receive time is 18:08:17 minus 5 seconds bias time = 18:08:12

A near-perfect match.

•	SRI receive time is 18:13:21

Fax receive time is 18:13:31 minus 5 seconds bias time = 18:13:26

Time difference = 5 seconds (sign doesn't matter) exceeds match time, so SRI routing fails.

To get the bias time right, set a large match time, such as 60 seconds, and restart the Faxgate Service. Send a fax through the PABX and when it has been received check the event log. Find the SRI and fax receive log entries and subtract the SRI receive time from the corresponding fax receive time to give the bias time. Try two or three faxes and average out the bias times.

The match time depends on the variability of PABX and/or PC timings under heavy load, and also on the site requirements. A large match time (over 60 seconds for example) will allow SRI matching to work every time, but with the possibility that the Faxgate Service occasionally routes a message to the wrong user. A small match time (less than 5 seconds) means that SRI is unlikely to route a message to the wrong user, but also that SRI will often fail (SRI failure doesn't lose a message, it just fails to assign routing digits, so the message gets sent to the Mail Gateway or Exchange administrator).


Errors

FAX Dial/ Answer Errors (30xx-33xx)

Fax Errors (37xx-39xx)

File Transfer Errors (34xx)

GammaFax Critical Errors (4xxx)

Gamma Fax Image Handling Errors (26xx)

GammaFax Queue Interface Errors (10xx)

GammaFax Queue Interface Errors (35xx)

Faxgate FAX Server Errors (7xxx, 9xxx)

API (MAPI) Errors (8xxx)

Brooktrout General Errors (52xxx)

Brooktrout Dial Errors (53xxx)

Brooktrout Hangup Errors (54xxx)

Other Brooktrout Errors (55xxx-57xxx)

Brooktrout Driver Errors (5900x)

Brooktrout Final Call Progress (FCP) Codes (593xx)


GammaFax Queue Interface Errors (10xx)

1000  Buffer-size error in input header

1001  The Queue File is being processed by another task

1002  Unable to create the Queue File

1003  Cannot find the Queue File

1004  Time-out - the Queue File is unavailable

1005  Queue File busy; protected process

1006  New Queue File is incompatible with old one

1007  Error in opening the Queue File; ran out of file handles

1008  Timed out; Queue File unavailable

1009  Error reading phone list file

1010  Bad string argument for time

1011  The queue record is being processed by another task

1012  The queue record was changed by another task

1013  The task awaiting processing

1014  Queue records not found

1015  Unable to create a queue record, file or directory, possibly because the disk is full

1016  File conversion failed

1017  Open error; DOS is out of file handles

1021  Bad date submission

1022  Bad time submission

1023  Queue file header is damaged

1024  Link list pointers are damaged

1025  Last record's pointers are damaged

1031  Incorrect list name

1032  Path not set

1033  File not found

1034  Path is invalid

1035  Bad file type specified

1036  Not a valid queue file

1040  Converter failed

1041  Non-convertible file

1042  Not full filename

1043  Unable to create more filenames

1044  File not opened

1045  List of files not opened

1046  List of files is empty

1054  Warning of end of list (EO) on a gfqFindNext call

1060  FAX driver rejected the message


GammaFax Image Handling Errors (26xx)

2650   No file handles are available.

2651   The file was not found.

2652   The file handle is invalid.

2653   The file cannot be read.

2654   The disk is full.

2655   Unexpected file error.

2660   Filename format was invalid.

2661   Filename wrapped.

2670   Page number was at the maximum.

2671   The page number wrapped.


FAX Dial/Answer Errors (30xx-33xx)

3001   Board i/o address is incorrect

3002   Illegal option for BACKGROUND command

3004   Illegal option for DEBUG command

3005   Illegal option for LOG command

3006   Illegal option for FILL command

3009   Illegal option for INT command

3013   Illegal option for MENU command

3019   Illegal option for SCAN command

3020   Illegal option for 2D (MR) command

3022   Illegal option for VERT command

3024   Illegal option for XFER file-transfer command

3027   Illegal option - undefined or unknown

3030   Operator aborted the operation from the keyboard

3031   Operator aborted the operation with a Control-Break

3032   Operator aborted the operation: exit flag set

3033   The answer operation requested by this record was completed

3035   Remote operator request

3036   Remote operator request

3040   A command was used that is currently undefined

3041   A command was used that is unknown to the program

3050   A problem occurred in opening the GFB command file

3051   A file I/O error occurred in opening the log file

3052   There was an error opening or reading the indirect file given in the phone-number field of a queue record.  The file does not exist or is not in a valid format

3060   Answer error - no open files

3061   Answer error - invalid drive in receive filename

3062   Answer error - insufficient disk space

3070   No answer received, busy or wrong number

3071   Dial error - blocked number or prohibited from use

3072   Dial error - a call came in while trying to dial (could be tangled cables or noisy line)

3073   Dial error - blocked number table full (France only)

3074   Dial error - blocked wait delay (France only)

3080   Dial error - no open files.  Check files to be sent

3090   Hold error - illegal time specified in HOLD command

3100   No file specified for LIST operation

3101   The program was unable to open the LIST file

3102   Too many files were specified in the send list (max. 50)

3103   List error - cannot find file named in list

3105   The LOG file specified was not opened

3106   The parameter for the LOG command is incorrect

3110   The NUMBERS command did not specify a file

3111   The NUMBERS command was unable to open the file

3120   Rate error - illegal value

3130   Receive error - the file specified was not opened

3140   Send error - too many files specified in SEND list

3141   Send error - a queue record had an invalid source type

3150   GCL reports file not found

3151   GCL reports buffer too short

3160   Specified font file not found

3161   Error reading font file

3170   Invalid image compression

3171   Invalid image width

3180   Filename indexing error - unable to index page count

3181   Filename indexing error - page-count overflow

3190   Filename indexing error - unable to index fax call

3191   Filename indexing error - fax-call number overflow

3200   A Digital ID Signal (DIS) sign-on was not received from the remote machine

3201   Nothing to poll; remote machines tray is empty

3202   Disconnect command received from other machine

3203   Poll attempt failed; remote machine did not send Digital Command Signal      (DCS)

3204   Training failed; line quality is unusable

3205   Image quality failed - probably noisy phone lines

3206   Protocol failure.  Disconnect sent to other machine

3210   Digital ID Signal (DIS) received a disconnect message

3211   Digital Command Signal (DCS) not received from sending machine

3212   A disconnect command was received from other machine

3213   Training failed; line quality unusable

3214   A disconnect command was received from other machine

3215   Protocol error caused a disconnect to be sent

3216   Digital Command Signal (DCS) not fine resolution.

3217   Digital Command Signal (DCS) not Error-correcting Mode (ECM).

3218   Page length not supported.

3219   Invalid rate in DCS

3220   A Digital ID Signal (DIS) sign-on was not received from the remote machine

3221   The remote machine failed to confirm the page (RTN)

3222   A Procedure Interrupt was received; no confirmation

3223   An unexpected disconnect message was received

3224   The remote machine failed to respond

3225   An unknown protocol message has been received

3230   A disconnect message has been received

3231   A protocol error occurred; a disconnect was sent

3232   Disconnect (DCN) sent; Modified Read (MR) error.

3233   An attempt was made to send a fine-resolution fax to a machine that is not capable of receiving fine resolution

3234   An attempt was made to send an Error-Correcting Mode (ECM) fax to a       machine that is not capable of receiving ECM faxes, and ECM was required for the transaction

3235   GammaFax training error. DCN sent,G4 reqd, DIS receiver did not have G4

3240   A disconnect message was received

3241   The remote did not send a Digital Transmit Command (DTC)

3242   The remote machine failed to confirm the page (RTN)

3243   A Procedure Interrupt was received, no confirmation

3244   Time-out - remote machine failed to respond

3245   An unknown response has been received from the remote machine

3250   A fax was received that had too many bad scan lines

3251   A fax was received that had too many bad scan lines

3252   A fax was received that had too many bad scan lines

3253   Too many bad scan lines.

3255   No scan lines in image.  The received image had no scan lines.

3256   Image too short.  The number of bytes received during image transmission was less than 50.

3260   DIS not received while in error-correcting mode

3261   DIS received disconnect while in error-correcting mode

3264   ECM error-Disconnect (DCN) received.

3265   DCN received in error-correcting mode; same as 3223

3266   RTN received in error-correcting mode; same as 3221

3267   PIN received in error-correcting mode; same as 3222

3268   Time-out received in error-correcting mode; same as 3224

3269   Unknown response in error-correcting mode; same as 3225

3270   Received partial page request at lowest allowed data rate in error-correcting mode - cannot downspeed

3300   I/O error attempting to read a file-either a physical problem or a file with no data

3301   GammaFax transmission-buffer underrun error

3310   Image size exceeds memory allocation

3311   Image-file length does not meet minimum requirements

3320   No file available for writing image data

3321   File-write error on image-file data; check disk space

3322   Image received exceeds memory allocation available

3350   No file open for writing received image data

3351   File-write error - check disk space available


File Transfer Errors (34xx)

3400   File-transfer initial acknowledge not received

3401   File transfer unable to get remote response

3402   File transfer encountered block sequence error

3403   File transfer encountered block sequence error

3404   File transfer failed to get sign-off response

3410   File-transfer initialisation message not received

3411   File transfer failed to respond to a reject message

3412   File transfer encountered too many frame errors

3413   File transfer failed to open the receive file

3414   File-transfer write error; check disk space available


GammaFax Queue Interface Errors (35xx)

3500   Queue record ID/ROM ID mismatch

3501   Unsupported BIOS service call

3510   MMServer CPU/disk did not provide service to the CP or CP MC board in time for transaction to complete.

3520   Queue record buffer in use.

3521   Invalid state for this operation.

3525   Rate error; rate requested in queue record is less than minimum rate.

3526   Rate error; rate requested in queue record is greater than maximum rate.


FAX Errors (37xx-39xx)

3700   Operating system error

3820   An unsupported line type was specified for a board

3821   Training algorithm detected FSK (previously 3921)

3822   P2 was not detected at the end of training (previously 3922)

3823   Training algorithm found no PN (previously 3923)

3830   No dial tone.

3901   Illegal line number.

3902   Function not implemented.

3903   Option value in call is not supported

3904   Parameter value in call is out of range

3905   Line request failed; line not open

3906   Protocol timeout on communications line

3907   No buffer was available for line protocol

3908   Length parameter specified was invalid

3909   Reject message received by line protocol

3910   Dial tone was not detected during dialling

3911   Ring detection did not complete successfully

3912   No answer tone detected: remote machine unavailable

3913   Carrier was not detected during image transfer

3914   Quality test failed; phone-line quality poor

3915   Quality test failed; phone-line quality poor

3916   Command time-out; command not received

3917   Command signal exceeded maximum value permitted

3918   Command signal exceeded maximum value permitted

3920   Protocol time-out

3930   Answer tone detected

3931   Busy tone detected

3932   PSTN congestion detected

3933   No audio energy detected

3934   Voice response to call

3935   Ringback detected.  A number was successfully reached but was not       responding correctly.

3936   Ringback, no answer tone.  There was no further ringing, no answer tone, perhaps no audio energy  (possibly voice).

3937   Ring-busy. First a ringing condition was detected, which was followed by a busy signal. Occurs if dialled number is answered and party hangs up. Indicates number is probably incorrect.

3938   Similar to 3936/3937 - ring no answer/ring busy

3940   Loop current was not detected after dialling

3941   Loop current failed during transmission (remote machine may have        disconnected)

3942   Loop current was detected prior to calling (e.g. handset may be in use)


GammaFax Critical Errors (4xxx)

4002   A critical error occurred.

4210   The Dispatcher is not running.

4211   The function has already been called once within the application.

4500   File to be sent could not be opened.

45xx    File to be sent could not be opened.


Faxgate FAX Server Errors (7xxx, 9xxx)

7015	No addresses

7019	MSN not available

7032	No message text

7066	Send file not found

7067	SEND_TYPE is invalid or not supported

7070	Binary File Transfer not supported

7101   FAX Server cannot access .fls file

7104   Cover page conversion error

7107   Too many files specified in .fls file

7108   TIFF merging failed (could be disk full or TIFF header problem)

7109   Document type not supported (no Component configured for this document type)

7200   TIFF conversion failed

7251   Receive FAX recovered after power loss.  No CSID or status details available.

9999	FAX Server status error


API (MMAPI) Errors (8xxx)

8001	Invalid date in #DS (must be dd-mm-yy or dd-mm-yyyy)

8002	Invalid time in #DS (must be hh:mm or hh:mm:ss)

8003	Invalid deferral day (incorrect ddd or dd-mm)


Brooktrout General Errors (52xxx)

52000	Error, but no further information provided

52001	File I/O error occurred

52002	Bad file format

52003	Line card firmware does not support capability

52004	Channel not in proper state

52005	Bad parameter value used

52006	Memory allocation error

52007	Channel not in required state


Brooktrout Dial Errors (53xxx)

53257	Dialling completed successfully

53258	No dial tone detected

53259	No loop current detected

53260	Local phone in use (country-specific)

53261	Busy trunk line detected

53265	T1 time slot busy

53266	Ringing detected during dialling


Brooktrout Hangup Errors (54xxx)

54001	Ring detect without a successful handshake

54002	Call aborted

54003	No loop current or A/ B signalling bits

54011	No answer, T30 T1 time out

54020	Unspecified transmit Phase B error

54021	Remote cannot receive or send

54022	COMREC error, Phase B transmit

54023	COMREC invalid command received

54024	RSPREC error

54025	DCS sent three times without response

54026	DIS/DTC received three times; DCS not recognised

54027	Failure to train

54028	RSPREC invalid response received

54029	DCN received in COMREC

54030	DCN received in RSPREC

54033	Incompatible fax formats, for example, a page width mismatch

54034	Invalid DMA count specified for transmitter

54035	Binary File Transfer specified, but ECM not enabled on transmitter

54036	Binary File Transfer mode specified, but not supported by receiver

54040	No response to RR after three tries

54041	No response to CTC, or response was not CTR

54042	T5 time out since receiving first RNR

54043	Do not continue with next message after receiving ERR

54044	ERR response to EOR-EOP or EOR-PRI-EOP

54051	RSPREC error

54052	No response to MPS, repeated three times

54053	Invalid response to MPS

54054	No response to EOP repeated three times

54055	Invalid response to EOP

54056	No response to EOM, repeated three times

54057	Invalid response to EOM

54060	DCN received in RSPREC

54061	No response received after third try for PPS-NULL

54062	No response received after third try for PPS-MPS

54063	No response received after third try for PPS-EOP

54064	No response received after third try for PPS-EOM

54065	No response received after third try for EOR-NULL

54066	No response received after third try for EOR-MPS

54067	No response received after third try for EOR-EOP

54068	No response received after third try for EOR-EOM

54070	Unspecified receive Phase B error

54071	RSPREC error

54072	COMREC error

54073	T.30 T2 time-out, expected page not received

54074	T.30 T1 time-out after EOM received

54075	DCN received in COMREC

54076	DCN received in RSPREC

54077	T.30 T2 time-out, expected page received

54078	Invalid DMA count specified for receiver

54079	Binary File Transfer specified, but ECM not supported by receiver

54101	RSPREC invalid response received

54102	COMREC invalid response received

54103	T3 time-out, no local response for remote voice interrupt

54104	T2 time-out, no command received after responding RNR

54105	DCN received for command received

54106	Command receive error

54107	Receive block count error in ECM mode

54108	Receive page count error in ECM mode

54240	No interrupt acknowledge, time-out

54241	Loop current still present while playing reorder tone after time-out

54242	T30 holdup time-out

54243	DCN received from host in receive holdup section for FAX PAD mode

54500	An error interrupt occurred, indicating a problem with the line card too severe to continue

54501	The application was unable to process interrupts from the line card fast enough, and information was lost.

54502	The channel generated an unexpected 03 (reset done) or 7F interrupt, indicating the existence of a firmware or hardware problem.

54503	An API command returned an error indicating the driver or operating system detected an error.


Other Brooktrout Errors (55xxx-57xxx)

55000-

55999	User function caused termination

56000-

56999	Time-out

57000-

57999	Alert occurred


Brooktrout Driver Errors (5900x)

59001	Cannot create TIFF file for receiving, detail in NT event log.

59002	Cannot open TIFF file for transmission, detail in NT event log.


Brooktrout Final Call Progress (FCP) Codes (593xx)

59301	BUSY1 - Remote end is busy, i.e. occupied

59302	BUSY2 - PABX is busy

59303	ROBUSY - Reorder busy, e.g. timed-out sender

59304	RECALL - Recall dial tone

59305	CONFIRM - Confirmation tone

59306	PULSE - Not used

59307	RING1 - US ringback

59308	RING2 - UK ringback

59316	HUMAN - Human voice detected

59317	ANSWER - Similar to human, except that there is silence

59318	DIALTON - Dial tone detected

59324	SILENCE - No signal detected for the silence time-out period.

59325	RNGNOANS - No answer tone

59326	G2DETECT - Detected Group 2 tones

59327	SITDETCT/SITINTC - Special Information detail

59328	QUIET - Indicates a T1 time-out

59329	SITVACODE - Special Information tone

59330	SITREORD - Special Information tone

59331	SITNOCIR - Special Information no circuit

59332	CNGDETCT - Remote end (during receive) started sending CNG

59333	RMTOFFHK - Remote fax machine went off-hook (T1 lines)

59334	SPECIALCP

59339	ANSWER_TONE_DETECT - Answer tone detected

59340    Unknown


Send Audit Dbase

Send Audit Dbase

When a message is completed and the Send Audit Dbase component is configured, a record is added to the file called audits.dbf in the AUDIT sub-directory of the FAX Server’s application directory.  This is a standard dBase III file format.

In addition to creating a dbase audit record an archive copy of the transmission TIFF file is created in a daily sub-directory under the AUDIT sub-directory.  The records within this database can be purged via Message purging with the option to purge records older than a specified number of hours or days.  The archived field(s) are also deleted at the time of purging.

To enable Send Auditing:

1.	Select File, New - Send Audit database.

To disable Send Auditing:

 1.	Select the Send Auditing icon, File, Remove.

The Send Audit dBase Component displays details about the contents of audits.dbf.

•	path and filename

•	no. of records

•	date and time of the oldest record

•	date and time of the newest record

•	a detail button to view the records in the send audit database

To enable Message purging:

1.	Select the Enable check box.

2.	Enter the desired amount of days or hours against the “purge messages older than” prompt.

3.	Select the appropriate radio button, either days or hours.

4.	Click OK to accept.


Receive Audit Dbase

Receive Audit Dbase

When a message is received and the Receive Audit Dbase component is configured, a record is added to the file called auditr.dbf in the AUDIT sub-directory of the FAX Server application directory.  This is a standard dBase III file format.

In addition to creating a dbase audit record, an archive copy of the received TIFF file is created in a daily sub-directory under the AUDIT sub-directory.  The records within this database can be purged via Message purging with the option to purge records older than a specified number of hours or days.  The archived file(s) are also deleted at the time of purging.

To enable Receive Auditing:

1.	Select File, New - Receive Audit database.

To disable Receive Auditing:

 1.	Select the Receive Auditing icon, File, Remove.

The Receive Audit dBase Component displays details about the contents of auditr.dbf.

•	path and filename

•	no. of records

•	date and time of the oldest record

•	date and time of the newest record

•	a detail button to view the records in the receive audit database

To enable Message purging:

1.	Select the Enable check box.

2.	Enter the desired amount of days or hours against the “purge messages older than” prompt.

5.	Select the appropriate radio button, either days or hours.

6.	Click OK to accept.


Pending.dbf

Pending.dbf

MESSAGEmanager maintains its queue of outgoing messages in two Dbase files: pending.dbf and complete.dbf.  Each record of the pending file defines a message which has not yet been successfully sent or has completed its retries.


Complete.dbf

Complete.dbf

MESSAGEmanager maintains its queue of outgoing messages in two Dbase files: pending.dbf and complete.dbf.  Each record of the complete file defines a message which has been successfully sent or has failed all its retries.


Receive.dbf

Receive.dbf

When an incoming fax message is received, MESSAGEmanager creates a record in the receive database receive.dbf.


Faxgate Service - Start

Faxgate Service - Start

Click this button to start the FAX Server.


Faxgate Service - Stop

Faxgate Service - Stop

Click this button to stop the FAX Server.  No messages will be sent or received while the FAX Server is not running.


Call Batching

Call Batching

The FAX Server will check the pending queue for any outgoing messages to the same fax number, these will be transmitted as one call.